Component Class Reference
[VST Implementation Helper Classes]

Default implementation for a VST 3 Component. More...

#include <vstcomponent.h>

Inheritance diagram for Component:
Inheritance graph
[legend]

Public Member Functions

 Component ()
 Constructor.
void setControllerClass (const FUID &cid)
 Sets the controller Class ID associated to its component.
tresult removeAudioBusses ()
 Removes all Audio Buses.
tresult removeEventBusses ()
 Removes all Event Buses.
tresult renameBus (MediaType type, BusDirection dir, int32 index, const String128 newName)
 Renames a specific bus.
tresult getControllerClassId (TUID classID)
tresult setIoMode (IoMode mode)
int32 getBusCount (MediaType type, BusDirection dir)
tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info)
tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
tresult setActive (TBool state)
tresult setState (IBStream *state)
tresult getState (IBStream *state)
tresult initialize (FUnknown *context)
tresult terminate ()
BusListgetBusList (MediaType type, BusDirection dir)
tresult removeAllBusses ()

Data Fields

OBJ_METHODS(Component,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IComponent)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected BusList 
audioInputs
BusList audioOutputs
BusList eventInputs
BusList eventOutputs

Detailed Description

Default implementation for a VST 3 Component.

Can be used as base class for a VST 3 component implementation.


Constructor & Destructor Documentation

Component (  ) 

Constructor.


Member Function Documentation

void setControllerClass ( const FUID cid  )  [inline]

Sets the controller Class ID associated to its component.

tresult removeAudioBusses (  ) 

Removes all Audio Buses.

tresult removeEventBusses (  ) 

Removes all Event Buses.

tresult renameBus ( MediaType  type,
BusDirection  dir,
int32  index,
const String128  newName 
)

Renames a specific bus.

Do not forget to inform the host about this (see IComponentHandler::restartComponent (kIoTitlesChanged)).

tresult getControllerClassId ( TUID  classID  )  [virtual]

Implements IComponent.

tresult setIoMode ( IoMode  mode  )  [virtual]

Implements IComponent.

int32 getBusCount ( MediaType  type,
BusDirection  dir 
) [virtual]

Implements IComponent.

tresult getBusInfo ( MediaType  type,
BusDirection  dir,
int32  index,
BusInfo info 
) [virtual]

Implements IComponent.

tresult getRoutingInfo ( RoutingInfo inInfo,
RoutingInfo outInfo 
) [virtual]

Implements IComponent.

tresult activateBus ( MediaType  type,
BusDirection  dir,
int32  index,
TBool  state 
) [virtual]

Implements IComponent.

tresult setActive ( TBool  state  )  [virtual]

Implements IComponent.

tresult setState ( IBStream state  )  [virtual]

Implements IComponent.

tresult getState ( IBStream state  )  [virtual]

Implements IComponent.

tresult initialize ( FUnknown context  )  [virtual]

Reimplemented from ComponentBase.

tresult terminate (  )  [virtual]

Reimplemented from ComponentBase.

BusList * getBusList ( MediaType  type,
BusDirection  dir 
)
tresult removeAllBusses (  ) 

Field Documentation

OBJ_METHODS (Component, ComponentBase) DEFINE_INTERFACES DEF_INTERFACE (IComponent) END_DEFINE_INTERFACES (ComponentBase) REFCOUNT_METHODS(ComponentBase) protected BusList audioInputs
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.